ebab7d0da53c51438720d60c6e2e467c - /page/wikibook/entry.mu

Micron Document

<!DOCTYPE html>

<title>OpenAPI Specification</title>

</head>

<span id="openzim-page-title" class="mw-page-title-main"><span class="mw-page-title-main">OpenAPI Specification</span></span>

</h1>

</header>

/* start https://en.wikipedia.org/ */

.mw-parser-output .infobox-subbox{padding:0;border:none;margin:-3px;width:auto;min-width:100%;font-size:100%;clear:none;float:none;background-color:transparent}.mw-parser-output .infobox-3cols-child{margin:auto}.mw-parser-output .infobox .navbar{font-size:100%}@media screen{html.skin-theme-clientpref-night .mw-parser-output .infobox-full-data:not(.notheme)>div:not(.notheme)[style]{background:#1f1f23!important;color:#f8f9fa}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .infobox-full-data:not(.notheme)>div:not(.notheme)[style]{background:#1f1f23!important;color:#f8f9fa}}@media(min-width:640px){body.skin--responsive .mw-parser-output .infobox-table{display:table!important}body.skin--responsive .mw-parser-output .infobox-table>caption{display:table-caption!important}body.skin--responsive .mw-parser-output .infobox-table>tbody{display:table-row-group}body.skin--responsive .mw-parser-output .infobox-table th,body.skin--responsive .mw-parser-output .infobox-table td{padding-left:inherit;padding-right:inherit}}

/* end https://en.wikipedia.org/ */

</style><table class="infobox hproduct"><caption class="infobox-title fn">OpenAPI</caption><tbody><tr><td colspan="2" class="infobox-subheader">OpenAPI Specification</td></tr><tr><td colspan="2" class="infobox-image"></td></tr><tr><th scope="row" class="infobox-label">Year started</th><td class="infobox-data">2010<span style="display: none;"> (<span class="bday dtstart published updated itvstart">2010</span>)</span></td></tr><tr><th scope="row" class="infobox-label">First published</th><td class="infobox-data">10 August 2011<span style="display: none;"> (<span class="bday dtstart published updated itvstart">2011-08-10</span>)</span></td></tr><tr><th scope="row" class="infobox-label">Latest version</th><td class="infobox-data">3.1.1<br>24 October 2024<span style="display: none;"> (<span class="bday dtstart published updated itvstart">2024-10-24</span>)</span></td></tr><tr><th scope="row" class="infobox-label">Website</th><td class="infobox-data"><span class="url"><a rel="nofollow" class="external text" href="https://openapis.org">openapis<wbr>.org</a></span></td></tr></tbody></table>

<p>The <b>OpenAPI Specification</b>, previously known as the <b>Swagger Specification</b>, is a <a href="Specification_(technical_standard)" title="Specification (technical standard)">specification</a> for a <a href="Machine-readable_medium" class="mw-redirect" title="Machine-readable medium">machine-readable</a> <a href="Interface_definition_language" class="mw-redirect" title="Interface definition language">interface definition language</a> for describing, producing, consuming and visualizing <a href="Web_API" title="Web API">web services</a>.<sup id="cite_ref-started_1-0" class="reference"><a href="#cite_note-started-1"><span class="cite-bracket">[</span>1<span class="cite-bracket">]</span></a></sup> Originally developed to support the <a href="Swagger_(software)" title="Swagger (software)">Swagger</a> framework, it became a separate project in 2015, overseen by the OpenAPI Initiative, an open-source collaboration project of the <a href="Linux_Foundation" title="Linux Foundation">Linux Foundation</a>.<sup id="cite_ref-2" class="reference"><a href="#cite_note-2"><span class="cite-bracket">[</span>2<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-charter_3-0" class="reference"><a href="#cite_note-charter-3"><span class="cite-bracket">[</span>3<span class="cite-bracket">]</span></a></sup>

</p><p>An OpenAPI Description (OAD)<sup id="cite_ref-glossary_4-0" class="reference"><a href="#cite_note-glossary-4"><span class="cite-bracket">[</span>4<span class="cite-bracket">]</span></a></sup> represents a formal description of an API that tools can use to generate code, documentation, test cases, and more.

</p>

<div class="mw-heading mw-heading2"><h2 id="History">History</h2></div>

<p><a href="Swagger_(software)" title="Swagger (software)">Swagger</a> development began in early 2010 by Tony Tam, who was working at online dictionary company <a href="Wordnik" title="Wordnik">Wordnik</a>.<sup id="cite_ref-5" class="reference"><a href="#cite_note-5"><span class="cite-bracket">[</span>5<span class="cite-bracket">]</span></a></sup>

</p><p>In March 2015, <a href="SmartBear_Software" title="SmartBear Software">SmartBear Software</a> acquired the open-source Swagger API specification from Reverb Technologies, Wordnik's parent company.<sup id="cite_ref-6" class="reference"><a href="#cite_note-6"><span class="cite-bracket">[</span>6<span class="cite-bracket">]</span></a></sup>

</p><p>In November 2015, SmartBear announced that it was donating the Swagger specification to a new organization called the OpenAPI Initiative, under the sponsorship of the <a href="Linux_Foundation" title="Linux Foundation">Linux Foundation</a>. Other founding member companies included <a href="3scale" title="3scale">3scale</a>, <a href="Apigee" title="Apigee">Apigee</a>, <a href="Capital_One" title="Capital One">Capital One</a>, <a href="Google" title="Google">Google</a>, <a href="IBM" title="IBM">IBM</a>, <a href="Intuit" title="Intuit">Intuit</a>, <a href="Microsoft" title="Microsoft">Microsoft</a>, <a href="PayPal" title="PayPal">PayPal</a>, and Restlet.<sup id="cite_ref-faqs_7-0" class="reference"><a href="#cite_note-faqs-7"><span class="cite-bracket">[</span>7<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-8" class="reference"><a href="#cite_note-8"><span class="cite-bracket">[</span>8<span class="cite-bracket">]</span></a></sup>

</p><p>On 1 January 2016, the Swagger specification was renamed the OpenAPI Specification (OAS) and was moved to a new <a href="GitHub" title="GitHub">GitHub</a> <a href="Software_repository" title="Software repository">repository</a>.<sup id="cite_ref-9" class="reference"><a href="#cite_note-9"><span class="cite-bracket">[</span>9<span class="cite-bracket">]</span></a></sup>

</p><p>In July 2017, the OpenAPI Initiative released version 3.0.0 of its specification.<sup id="cite_ref-10" class="reference"><a href="#cite_note-10"><span class="cite-bracket">[</span>10<span class="cite-bracket">]</span></a></sup>

</p><p>In February 2021, the OpenAPI Initiative released version 3.1.0.<sup id="cite_ref-11" class="reference"><a href="#cite_note-11"><span class="cite-bracket">[</span>11<span class="cite-bracket">]</span></a></sup> Major changes in OpenAPI Specification 3.1.0 include JSON schema vocabularies alignment, new top-level elements for describing webhooks that are registered and managed out of band, support for identifying API licenses using the standard SPDX identifier, allowance of descriptions alongside the use of schema references and a change to make the PathItems object optional to simplify creation of reusable libraries of components.<sup id="cite_ref-12" class="reference"><a href="#cite_note-12"><span class="cite-bracket">[</span>12<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-13" class="reference"><a href="#cite_note-13"><span class="cite-bracket">[</span>13<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-14" class="reference"><a href="#cite_note-14"><span class="cite-bracket">[</span>14<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading3"><h3 id="Consolidation_of_Formats">Consolidation of Formats</h3></div>

<p>Two somewhat similar technologies, <a href="MuleSoft" title="MuleSoft">MuleSoft</a>'s <a href="RESTful_API_Modeling_Language" class="mw-redirect" title="RESTful API Modeling Language">RESTful API Modeling Language</a> (RAML) and Apiary's API Blueprint, had been developed around the same time as what was then still called the Swagger Specification.

</p><p>The producers of both formats later joined the OpenAPI Initiative: Apiary in 2016<sup id="cite_ref-15" class="reference"><a href="#cite_note-15"><span class="cite-bracket">[</span>15<span class="cite-bracket">]</span></a></sup> and MuleSoft in 2017.<sup id="cite_ref-RAML_16-0" class="reference"><a href="#cite_note-RAML-16"><span class="cite-bracket">[</span>16<span class="cite-bracket">]</span></a></sup> Both have added support for the OAS.<sup id="cite_ref-17" class="reference"><a href="#cite_note-17"><span class="cite-bracket">[</span>17<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-RAML_16-1" class="reference"><a href="#cite_note-RAML-16"><span class="cite-bracket">[</span>16<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading3"><h3 id="Release_dates">Release dates</h3></div>

<th>Version</th>

<th>Notes<sup id="cite_ref-18" class="reference"><a href="#cite_note-18"><span class="cite-bracket">[</span>18<span class="cite-bracket">]</span></a></sup>

</th></tr>

<tr>

<td>3.1.1

</td>

<td>2024-10-24

</td>

<td>Patch release of the OpenAPI Specification 3.1.1

</td></tr>

<tr>

<td>Release of the OpenAPI Specification 3.1.0

</td></tr>

<tr>

<td>3.0.4

</td>

<td>2024-10-24

</td>

<td>Patch release of the OpenAPI Specification 3.0.4

</td></tr>

<tr>

<td>3.0.3

</td>

<td>2020-02-20

</td>

<td>Patch release of the OpenAPI Specification 3.0.3

</td></tr>

<tr>

<td>3.0.2

</td>

<td>2018-10-08

</td>

<td>Patch release of the OpenAPI Specification 3.0.2

</td></tr>

<tr>

<td>3.0.1

</td>

<td>2017-12-06

</td>

<td>Patch release of the OpenAPI Specification 3.0.1

</td></tr>

<tr>

<td>Release of the OpenAPI Specification 3.0.0

</td></tr>

<tr>

<td>Release of Swagger 2.0

</td></tr>

<tr>

<td>Initial release of the formal document

</td></tr>

<tr>

<td>Release of Swagger 1.1

</td></tr>

<tr>

<td>First release of the Swagger Specification

</td></tr></tbody></table>

<div class="mw-heading mw-heading2"><h2 id="Usage">Usage</h2></div>

<p>The OAS describes the format for OpenAPI Descriptions (OADs),<sup id="cite_ref-glossary_4-1" class="reference"><a href="#cite_note-glossary-4"><span class="cite-bracket">[</span>4<span class="cite-bracket">]</span></a></sup> which can be used by a variety of applications, libraries, and tools.

</p><p>Applications can use OADs to automatically generate documentation of methods, parameters and <a href="Data_model" title="Data model">data models</a>. This helps keep the <a href="Software_documentation" title="Software documentation">documentation</a>, client libraries and source code in sync.<sup id="cite_ref-19" class="reference"><a href="#cite_note-19"><span class="cite-bracket">[</span>19<span class="cite-bracket">]</span></a></sup>

</p><p>When an OAD is used to generate source code stubs for servers, the process is called <a href="Scaffold_(programming)" title="Scaffold (programming)">scaffolding</a>.

</p>

<div class="mw-heading mw-heading3"><h3 id="Relationships_to_software_engineering_practices">Relationships to software engineering practices</h3></div>

<p>The paradigm of agreeing on an API contract first and then programming business logic afterwards, in contrast to coding the program first and then writing a retrospective description of its behavior as the contract, is called contract-first development. Since the interface is determined before any code is written, downstream developers can <a href="Mock_object" title="Mock object">mock</a> the <a href="Server_(computing)" title="Server (computing)">server</a> behavior and start testing right away.<sup id="cite_ref-20" class="reference"><a href="#cite_note-20"><span class="cite-bracket">[</span>20<span class="cite-bracket">]</span></a></sup> In this sense, contract-first development is also a practice of <a href="Shift-left_testing" title="Shift-left testing">shift-left testing</a>.

</p>

<div class="mw-heading mw-heading2"><h2 id="Features">Features</h2></div>

<p>The OpenAPI Specification is language-agnostic. With OpenAPI's <a href="Declarative_programming" title="Declarative programming">declarative</a> resource specification, clients can understand and consume services without knowledge of server implementation or access to the server code.<sup id="cite_ref-started_1-1" class="reference"><a href="#cite_note-started-1"><span class="cite-bracket">[</span>1<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Tools_that_work_with_OpenAPI">Tools that work with OpenAPI</h2></div>

<p>The OpenAPI Initiative maintains a list of implementations for version 3.0 of the specification.<sup id="cite_ref-21" class="reference"><a href="#cite_note-21"><span class="cite-bracket">[</span>21<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Annual_conference">Annual conference</h2></div>

<p>The OpenAPI Initiative sponsors an annual API Specifications Conference (ASC). The event has its origins in the API Strategy and Practice Conference (APIStrat) that ran for many years and became part of the OpenAPI Initiative in 2016.

</p>

<ul><li><a href="Representational_state_transfer" class="mw-redirect" title="Representational state transfer">Representational state transfer</a></li>

<li><a href="Data_modeling" title="Data modeling">Data modelling</a></li></ul>

<div class="mw-heading mw-heading2"><h2 id="References">References</h2></div>

/* start https://en.wikipedia.org/ */

.mw-parser-output .reflist{margin-bottom:0.5em;list-style-type:decimal}@media screen{.mw-parser-output .reflist{font-size:90%}}.mw-parser-output .reflist .references{font-size:100%;margin-bottom:0;list-style-type:inherit}.mw-parser-output .reflist-columns-2{column-width:30em}.mw-parser-output .reflist-columns-3{column-width:25em}.mw-parser-output .reflist-columns{margin-top:0.3em}.mw-parser-output .reflist-columns ol{margin-top:0}.mw-parser-output .reflist-columns li{page-break-inside:avoid;break-inside:avoid-column}.mw-parser-output .reflist-upper-alpha{list-style-type:upper-alpha}.mw-parser-output .reflist-upper-roman{list-style-type:upper-roman}.mw-parser-output .reflist-lower-alpha{list-style-type:lower-alpha}.mw-parser-output .reflist-lower-greek{list-style-type:lower-greek}.mw-parser-output .reflist-lower-roman{list-style-type:lower-roman}

/* end https://en.wikipedia.org/ */

</style><div class="reflist">

/* start https://en.wikipedia.org/ */

.mw-parser-output cite.citation{font-style:inherit;word-wrap:break-word}.mw-parser-output .citation q{quotes:"\"""\"""'""'"}.mw-parser-output .citation:target{background-color:rgba(0,127,255,0.133)}.mw-parser-output .id-lock-free.id-lock-free a{background:url("./mw/Lock-green.svg")right 0.1em center/9px no-repeat}.mw-parser-output .id-lock-limited.id-lock-limited a,.mw-parser-output .id-lock-registration.id-lock-registration a{background:url("./mw/Lock-gray-alt-2.svg")right 0.1em center/9px no-repeat}.mw-parser-output .id-lock-subscription.id-lock-subscription a{background:url("./mw/Lock-red-alt-2.svg")right 0.1em center/9px no-repeat}.mw-parser-output .cs1-ws-icon a{background:url("./mw/Wikisource-logo.svg")right 0.1em center/12px no-repeat}body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-free a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-limited a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-registration a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-subscription a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .cs1-ws-icon a{background-size:contain;padding:0 1em 0 0}.mw-parser-output .cs1-code{color:inherit;background:inherit;border:none;padding:inherit}.mw-parser-output .cs1-hidden-error{display:none;color:var(--color-error,#d33)}.mw-parser-output .cs1-visible-error{color:var(--color-error,#d33)}.mw-parser-output .cs1-maint{display:none;color:#085;margin-left:0.3em}.mw-parser-output .cs1-kern-left{padding-left:0.2em}.mw-parser-output .cs1-kern-right{padding-right:0.2em}.mw-parser-output .citation .mw-selflink{font-weight:inherit}@media screen{.mw-parser-output .cs1-format{font-size:95%}html.skin-theme-clientpref-night .mw-parser-output .cs1-maint{color:#18911f}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .cs1-maint{color:#18911f}}

/* end https://en.wikipedia.org/ */

</style><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://learn.openapis.org/">"OpenAPI Documentation: Getting Started"</a>. <i>Learn OpenAPI</i>. The OpenAPI Initiative<span class="reference-accessdate">. Retrieved <span class="nowrap">17 September</span> 2024</span>.</cite></span>

</li>

<li id="cite_note-2"><span class="mw-cite-backlink"><b><a href="#cite_ref-2">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20231031170437/https://www.linuxfoundation.org/press/press-release/new-collaborative-project-to-extend-swagger-specification-for-building-connected-applications-and-services">"New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services"</a>. Archived from <a rel="nofollow" class="external text" href="https://www.linuxfoundation.org/press/press-release/new-collaborative-project-to-extend-swagger-specification-for-building-connected-applications-and-services">the original</a> on 31 October 2023.</cite></span>

</li>

<li id="cite_note-charter-3"><span class="mw-cite-backlink"><b><a href="#cite_ref-charter_3-0">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20250126133749/https://www.openapis.org/participate/how-to-contribute/governance">"OpenAPI Initiative Charter"</a>. <i>OpenAPI Initiative</i>. Archived from <a rel="nofollow" class="external text" href="https://www.openapis.org/participate/how-to-contribute/governance">the original</a> on 26 January 2025<span class="reference-accessdate">. Retrieved <span class="nowrap">12 November</span> 2019</span>.</cite></span>

</li>

<li id="cite_note-glossary-4"><span class="mw-cite-backlink">^ <a href="#cite_ref-glossary_4-0"><sup><i><b>a</b></i></sup></a> <a href="#cite_ref-glossary_4-1"><sup><i><b>b</b></i></sup></a></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://learn.openapis.org/glossary.html">"OpenAPI Documentation: Glossary"</a>. <i>Learn OpenAPI</i>. The OpenAPI Initiative. 2023<span class="reference-accessdate">. Retrieved <span class="nowrap">17 September</span> 2024</span>.</cite></span>

</li>

<li id="cite_note-5"><span class="mw-cite-backlink"><b><a href="#cite_ref-5">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://sdtimes.com/apis/swagger-creator-joins-smartbear/">"Swagger creator joins SmartBear"</a>. 28 September 2015<span class="reference-accessdate">. Retrieved <span class="nowrap">6 August</span> 2019</span>.</cite></span>

</li>

<li id="cite_note-6"><span class="mw-cite-backlink"><b><a href="#cite_ref-6">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://smartbear.com/news/news-releases/sponsorship-of-swagger/">"SmartBear Assumes Sponsorship of Swagger API Open Source Project"</a>. <i>SmartBear</i><span class="reference-accessdate">. Retrieved <span class="nowrap">25 March</span> 2015</span>.</cite></span>

</li>

<li id="cite_note-faqs-7"><span class="mw-cite-backlink"><b><a href="#cite_ref-faqs_7-0">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.openapis.org/faq#OAIFAQ-History">"FAQ"</a>. <i>OpenAPI Initiative</i><span class="reference-accessdate">. Retrieved <span class="nowrap">12 November</span> 2019</span>.</cite></span>

</li>

<li id="cite_note-8"><span class="mw-cite-backlink"><b><a href="#cite_ref-8">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20160427104213/http://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building">"New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services"</a>. <i>linuxfoundation.org</i>. Archived from <a rel="nofollow" class="external text" href="http://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building">the original</a> on 27 April 2016<span class="reference-accessdate">. Retrieved <span class="nowrap">22 April</span> 2016</span>.</cite></span>

</li>

<li id="cite_note-9"><span class="mw-cite-backlink"><b><a href="#cite_ref-9">^</a></b></span> <span class="reference-text"><cite id="CITEREFOpenAPI_Initiative" class="citation web cs1">OpenAPI Initiative. <a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification">"OpenAPI Specification"</a>. <i>GitHub</i><span class="reference-accessdate">. Retrieved <span class="nowrap">12 November</span> 2019</span>.</cite></span>

</li>

<li id="cite_note-10"><span class="mw-cite-backlink"><b><a href="#cite_ref-10">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.openapis.org/blog/2017/07/26/the-oai-announces-the-openapi-specification-3-0-0">"The OAI Announces the OpenAPI Specification 3.0.0"</a>. <i>OpenAPIs</i>. 26 July 2017<span class="reference-accessdate">. Retrieved <span class="nowrap">19 April</span> 2018</span>.</cite></span>

</li>

<li id="cite_note-11"><span class="mw-cite-backlink"><b><a href="#cite_ref-11">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.linux.com/news/openapi-specification-3-1-0-available-now">"OpenAPI Specification 3.1.0 Available Now"</a>. <i>Linux.com</i>. 26 April 2021<span class="reference-accessdate">. Retrieved <span class="nowrap">26 April</span> 2021</span>.</cite></span>

</li>

<li id="cite_note-12"><span class="mw-cite-backlink"><b><a href="#cite_ref-12">^</a></b></span> <span class="reference-text"><cite id="CITEREFCharboneau2021" class="citation web cs1">Charboneau, Tyler (7 April 2021). <a rel="nofollow" class="external text" href="https://nordicapis.com/whats-new-in-openapi-3-1-0/">"What's New in OpenAPI 3.1.0?"</a>. <i>Nordic APIs</i><span class="reference-accessdate">. Retrieved <span class="nowrap">7 April</span> 2021</span>.</cite></span>

</li>

<li id="cite_note-13"><span class="mw-cite-backlink"><b><a href="#cite_ref-13">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.openapis.org/blog/2021/02/18/openapi-specification-3-1-released">"OpenAPI Specification 3.1.0 Released"</a>. <i>OpenAPI Initiative</i>. 18 February 2021<span class="reference-accessdate">. Retrieved <span class="nowrap">18 February</span> 2021</span>.</cite></span>

</li>

<li id="cite_note-14"><span class="mw-cite-backlink"><b><a href="#cite_ref-14">^</a></b></span> <span class="reference-text"><cite id="CITEREFSturgeon2021" class="citation web cs1">Sturgeon, Phil (16 February 2021). <a rel="nofollow" class="external text" href="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0">"Migrating from OpenAPI 3.0 to 3.1.0"</a>. <i>OpenAPI Initiative</i><span class="reference-accessdate">. Retrieved <span class="nowrap">16 February</span> 2021</span>.</cite></span>

</li>

<li id="cite_note-15"><span class="mw-cite-backlink"><b><a href="#cite_ref-15">^</a></b></span> <span class="reference-text"><cite id="CITEREFLensmar2016" class="citation web cs1">Lensmar, Ole (23 February 2016). <a rel="nofollow" class="external text" href="https://www.openapis.org/blog/2016/02/23/oai-update-new-members-openapi-spec-3-0-progress-and-more">"OAI Update – new members, OpenAPI Spec 3.0 progress, and more!"</a>. <i>The OpenAPI Initiative</i><span class="reference-accessdate">. Retrieved <span class="nowrap">13 October</span> 2024</span>.</cite></span>

</li>

<li id="cite_note-RAML-16"><span class="mw-cite-backlink">^ <a href="#cite_ref-RAML_16-0"><sup><i><b>a</b></i></sup></a> <a href="#cite_ref-RAML_16-1"><sup><i><b>b</b></i></sup></a></span> <span class="reference-text"><cite id="CITEREFAvram2017" class="citation web cs1">Avram, Abel (6 May 2017). <a rel="nofollow" class="external text" href="https://www.infoq.com/news/2017/05/api-raml-oas">"The HTTP API space is Consolidating around OAS"</a>. <i>InfoQ</i><span class="reference-accessdate">. Retrieved <span class="nowrap">14 May</span> 2017</span>.</cite></span>

</li>

<li id="cite_note-17"><span class="mw-cite-backlink"><b><a href="#cite_ref-17">^</a></b></span> <span class="reference-text"><cite id="CITEREFNesetril2016" class="citation web cs1">Nesetril, Jakub (18 January 2016). <a rel="nofollow" class="external text" href="https://blog.apiary.io/We-ve-got-Swagger">"We've got Swagger"</a>. <i>Oracle Apiary</i><span class="reference-accessdate">. Retrieved <span class="nowrap">13 October</span> 2024</span>.</cite></span>

</li>

<li id="cite_note-18"><span class="mw-cite-backlink"><b><a href="#cite_ref-18">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md">"OpenAPI Specification Version 3.1.0"</a>. <i>GitHub</i><span class="reference-accessdate">. Retrieved <span class="nowrap">7 November</span> 2023</span>.</cite></span>

</li>

<li id="cite_note-19"><span class="mw-cite-backlink"><b><a href="#cite_ref-19">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://learn.openapis.org/introduction.html">"OpenAPI Documentation: Introduction"</a>. <i>Learn OpenAPI</i>. The OpenAPI Initiative. 2023<span class="reference-accessdate">. Retrieved <span class="nowrap">17 September</span> 2024</span>.</cite></span>

</li>

<li id="cite_note-20"><span class="mw-cite-backlink"><b><a href="#cite_ref-20">^</a></b></span> <span class="reference-text"><cite id="CITEREFPreibisch2018" class="citation book cs1">Preibisch, Sascha (2018). <i>API Development: A Practical Guide for Business Implementation Success</i>. [Berkeley, CA]: Apress. <a href="ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <bdi>978-1-4842-4140-0</bdi>. <a href="OCLC_(identifier)" class="mw-redirect" title="OCLC (identifier)">OCLC</a> <a rel="nofollow" class="external text" href="https://search.worldcat.org/oclc/1076234393">1076234393</a>. <q>Having the Swagger (or for that matter, any other machine-readable) document available, team members can start working on their part of the project at the same time.</q></cite></span>

</li>

<li id="cite_note-21"><span class="mw-cite-backlink"><b><a href="#cite_ref-21">^</a></b></span> <span class="reference-text"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://tools.openapis.org/">"OpenAPI Tooling"</a>. <i>OpenAPI Tooling</i>. The OpenAPI Initiative<span class="reference-accessdate">. Retrieved <span class="nowrap">17 September</span> 2024</span>.</cite></span>

</li>

</ol></div></div>

<div class="mw-heading mw-heading2"><h2 id="Bibliography">Bibliography</h2></div>

/* start https://en.wikipedia.org/ */

.mw-parser-output .refbegin{margin-bottom:0.5em}.mw-parser-output .refbegin-hanging-indents>ul{margin-left:0}.mw-parser-output .refbegin-hanging-indents>ul>li{margin-left:0;padding-left:3.2em;text-indent:-3.2em}.mw-parser-output .refbegin-hanging-indents ul,.mw-parser-output .refbegin-hanging-indents ul li{list-style:none}@media(max-width:720px){.mw-parser-output .refbegin-hanging-indents>ul>li{padding-left:1.6em;text-indent:-1.6em}}.mw-parser-output .refbegin-columns{margin-top:0.3em}.mw-parser-output .refbegin-columns ul{margin-top:0}.mw-parser-output .refbegin-columns li{page-break-inside:avoid;break-inside:avoid-column}@media screen{.mw-parser-output .refbegin{font-size:90%}}

/* end https://en.wikipedia.org/ */

</style><div class="refbegin" style="">

<ul><li><cite id="CITEREFHauptKarastoyanovaLeymannSchroth2014" class="citation conference cs1">Haupt, F.; Karastoyanova, D.; Leymann, F.; Schroth, B. (2014). <i>A Model-Driven Approach for REST Compliant Services</i>. <a href="International_Conference_on_Web_Services" title="International Conference on Web Services">ICWS</a> 2014. <i>2014 IEEE International Conference on Web Services</i>. pp. <span class="nowrap">129–</span>136. <a href="Doi_(identifier)" class="mw-redirect" title="Doi (identifier)">doi</a>:<a rel="nofollow" class="external text" href="https://doi.org/10.1109%2FICWS.2014.30">10.1109/ICWS.2014.30</a>. <a href="ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <bdi>978-1-4799-5054-6</bdi>.</cite></li>

<li><cite id="CITEREFPautasso2021" class="citation book cs1">Pautasso, Cesare (2021). <a rel="nofollow" class="external text" href="https://leanpub.com/beautiful-apis/"><i>Beautiful APIs</i></a>. LeanPub. p. 100.</cite></li></ul>

</div>

<div class="mw-heading mw-heading2"><h2 id="External_links">External links</h2></div>

<ul><li><a rel="nofollow" class="external text" href="https://openapis.org/">OpenAPI Initiative (OAI) website</a></li>

<li><a rel="nofollow" class="external text" href="https://events.linuxfoundation.org/openapi-asc/">API Specifications Conference (ASC) website</a></li>

<li><a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification">OpenAPI Specification on GitHub</a></li>

<li><a rel="nofollow" class="external text" href="https://github.com/APIs-guru/openapi-directory/">Directory of OpenAPI Descriptions</a></li>

<li><a rel="nofollow" class="external text" href="https://learn.openapis.org/examples/">Example OpenAPI Descriptions on the OAI's official Learn OpenAPIs site</a></li></ul>

</p>

/* start https://en.wikipedia.org/ */

.mw-parser-output .hlist dl,.mw-parser-output .hlist ol,.mw-parser-output .hlist ul{margin:0;padding:0}.mw-parser-output .hlist dd,.mw-parser-output .hlist dt,.mw-parser-output .hlist li{margin:0;display:inline}.mw-parser-output .hlist.inline,.mw-parser-output .hlist.inline dl,.mw-parser-output .hlist.inline ol,.mw-parser-output .hlist.inline ul,.mw-parser-output .hlist dl dl,.mw-parser-output .hlist dl ol,.mw-parser-output .hlist dl ul,.mw-parser-output .hlist ol dl,.mw-parser-output .hlist ol ol,.mw-parser-output .hlist ol ul,.mw-parser-output .hlist ul dl,.mw-parser-output .hlist ul ol,.mw-parser-output .hlist ul ul{display:inline}.mw-parser-output .hlist .mw-empty-li{display:none}.mw-parser-output .hlist dt::after{content:": "}.mw-parser-output .hlist dd::after,.mw-parser-output .hlist li::after{content:" · ";font-weight:bold}.mw-parser-output .hlist dd:last-child::after,.mw-parser-output .hlist dt:last-child::after,.mw-parser-output .hlist li:last-child::after{content:none}.mw-parser-output .hlist dd dd:first-child::before,.mw-parser-output .hlist dd dt:first-child::before,.mw-parser-output .hlist dd li:first-child::before,.mw-parser-output .hlist dt dd:first-child::before,.mw-parser-output .hlist dt dt:first-child::before,.mw-parser-output .hlist dt li:first-child::before,.mw-parser-output .hlist li dd:first-child::before,.mw-parser-output .hlist li dt:first-child::before,.mw-parser-output .hlist li li:first-child::before{content:" (";font-weight:normal}.mw-parser-output .hlist dd dd:last-child::after,.mw-parser-output .hlist dd dt:last-child::after,.mw-parser-output .hlist dd li:last-child::after,.mw-parser-output .hlist dt dd:last-child::after,.mw-parser-output .hlist dt dt:last-child::after,.mw-parser-output .hlist dt li:last-child::after,.mw-parser-output .hlist li dd:last-child::after,.mw-parser-output .hlist li dt:last-child::after,.mw-parser-output .hlist li li:last-child::after{content:")";font-weight:normal}.mw-parser-output .hlist ol{counter-reset:listitem}.mw-parser-output .hlist ol>li{counter-increment:listitem}.mw-parser-output .hlist ol>li::before{content:" "counter(listitem)"\a0 "}.mw-parser-output .hlist dd ol>li:first-child::before,.mw-parser-output .hlist dt ol>li:first-child::before,.mw-parser-output .hlist li ol>li:first-child::before{content:" ("counter(listitem)"\a0 "}

/* end https://en.wikipedia.org/ */

</style><style data-mw-deduplicate="TemplateStyles:r1236075235">

/* start https://en.wikipedia.org/ */

.mw-parser-output .navbox{box-sizing:border-box;border:1px solid #a2a9b1;width:100%;clear:both;font-size:88%;text-align:center;padding:1px;margin:1em auto 0}.mw-parser-output .navbox .navbox{margin-top:0}.mw-parser-output .navbox+.navbox,.mw-parser-output .navbox+.navbox-styles+.navbox{margin-top:-1px}.mw-parser-output .navbox-inner,.mw-parser-output .navbox-subgroup{width:100%}.mw-parser-output .navbox-group,.mw-parser-output .navbox-title,.mw-parser-output .navbox-abovebelow{padding:0.25em 1em;line-height:1.5em;text-align:center}.mw-parser-output .navbox-group{white-space:nowrap;text-align:right}.mw-parser-output .navbox,.mw-parser-output .navbox-subgroup{background-color:#fdfdfd}.mw-parser-output .navbox-list{line-height:1.5em;border-color:#fdfdfd}.mw-parser-output .navbox-list-with-group{text-align:left;border-left-width:2px;border-left-style:solid}.mw-parser-output tr+tr>.navbox-abovebelow,.mw-parser-output tr+tr>.navbox-group,.mw-parser-output tr+tr>.navbox-image,.mw-parser-output tr+tr>.navbox-list{border-top:2px solid #fdfdfd}.mw-parser-output .navbox-title{background-color:#ccf}.mw-parser-output .navbox-abovebelow,.mw-parser-output .navbox-group,.mw-parser-output .navbox-subgroup .navbox-title{background-color:#ddf}.mw-parser-output .navbox-subgroup .navbox-group,.mw-parser-output .navbox-subgroup .navbox-abovebelow{background-color:#e6e6ff}.mw-parser-output .navbox-even{background-color:#f7f7f7}.mw-parser-output .navbox-odd{background-color:transparent}.mw-parser-output .navbox .hlist td dl,.mw-parser-output .navbox .hlist td ol,.mw-parser-output .navbox .hlist td ul,.mw-parser-output .navbox td.hlist dl,.mw-parser-output .navbox td.hlist ol,.mw-parser-output .navbox td.hlist ul{padding:0.125em 0}.mw-parser-output .navbox .navbar{display:block;font-size:100%}.mw-parser-output .navbox-title .navbar{float:left;text-align:left;margin-right:0.5em}body.skin--responsive .mw-parser-output .navbox-image img{max-width:none!important}@media print{body.ns-0 .mw-parser-output .navbox{display:none!important}}

/* end https://en.wikipedia.org/ */

</style></div><div role="navigation" class="navbox" aria-labelledby="Linux_Foundation54" style="padding:3px"><table class="nowraplinks mw-collapsible autocollapse navbox-inner" style="border-spacing:0;background:transparent;color:inherit"><tbody><tr><th scope="col" class="navbox-title" colspan="2"><style data-mw-deduplicate="TemplateStyles:r1239400231">

/* start https://en.wikipedia.org/ */

.mw-parser-output .navbar{display:inline;font-size:88%;font-weight:normal}.mw-parser-output .navbar-collapse{float:left;text-align:left}.mw-parser-output .navbar-boxtext{word-spacing:0}.mw-parser-output .navbar ul{display:inline-block;white-space:nowrap;line-height:inherit}.mw-parser-output .navbar-brackets::before{margin-right:-0.125em;content:"[ "}.mw-parser-output .navbar-brackets::after{margin-left:-0.125em;content:" ]"}.mw-parser-output .navbar li{word-spacing:-0.125em}.mw-parser-output .navbar a>span,.mw-parser-output .navbar a>abbr{text-decoration:inherit}.mw-parser-output .navbar-mini abbr{font-variant:small-caps;border-bottom:none;text-decoration:none;cursor:inherit}.mw-parser-output .navbar-ct-full{font-size:114%;margin:0 7em}.mw-parser-output .navbar-ct-mini{font-size:114%;margin:0 4em}html.skin-theme-clientpref-night .mw-parser-output .navbar li a abbr{color:var(--color-base)!important}@media(prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .navbar li a abbr{color:var(--color-base)!important}}@media print{.mw-parser-output .navbar{display:none!important}}

/* end https://en.wikipedia.org/ */

</style><div id="Linux_Foundation54" style="font-size:114%;margin:0 4em"><a href="Linux_Foundation" title="Linux Foundation">Linux Foundation</a></div></th></tr><tr><th scope="row" class="navbox-group" style="width:1%">Sub-foundations</th><td class="navbox-list-with-group navbox-list navbox-odd hlist" style="width:100%;padding:0"><div style="padding:0 0.25em">

<ul><li><a href="Cloud_Native_Computing_Foundation" title="Cloud Native Computing Foundation">Cloud Native Computing Foundation</a></li>

<li><a href="Cloud_Foundry" title="Cloud Foundry">Cloud Foundry</a></li>

<li><a href="OpenJS_Foundation" title="OpenJS Foundation">OpenJS Foundation</a></li>

<li><a href="LF_Energy" title="LF Energy">LF Energy</a></li>

<li><a href="Presto_(SQL_query_engine)" title="Presto (SQL query engine)">Presto Foundation</a></li>

<li><a href="Open_Source_Security_Foundation" title="Open Source Security Foundation">Open Source Security Foundation</a></li>

<li><a href="Overture_Maps_Foundation" title="Overture Maps Foundation">Overture Maps Foundation</a></li></ul>

</div></td></tr><tr><th scope="row" class="navbox-group" style="width:1%">Initiatives</th><td class="navbox-list-with-group navbox-list navbox-even hlist" style="width:100%;padding:0"><div style="padding:0 0.25em">

<ul><li><a href="Open_Container_Initiative" title="Open Container Initiative">Open Container Initiative</a></li>

<li><a href="Core_Infrastructure_Initiative" title="Core Infrastructure Initiative">Core Infrastructure Initiative</a></li>

<li><a href="OpenAPI_Initiative" class="mw-redirect" title="OpenAPI Initiative">OpenAPI Initiative</a></li></ul>

</div></td></tr><tr><th scope="row" class="navbox-group" style="width:1%">Projects</th><td class="navbox-list-with-group navbox-list navbox-odd hlist" style="width:100%;padding:0"><div style="padding:0 0.25em">

<ul><li><a href="Open_Mainframe_Project" title="Open Mainframe Project">Open Mainframe Project</a></li>

<li><a href="SONiC_(operating_system)" title="SONiC (operating system)">SONiC</a></li>

<li><a href="Hyperledger" title="Hyperledger">Hyperledger</a></li></ul>

</div></td></tr></tbody></table></div></div><div><div class="zim-footer">

This article is issued from <a class="external text" title="Last edited on 2025-07-19" href="https://en.wikipedia.org/wiki/?title=OpenAPI_Specification&oldid=1301299382">Wikipedia</a>. The text is available under <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">Creative Commons Attribution-Share Alike 4.0</a> unless otherwise noted. Additional terms may apply for the media files.

</div>

</div></div>

</div>

</main>

</div>

</body></html>